Summary

Fully Qualified Name:

CodeIgniter\Email\Email

Description

Methods

Name	Description	Defined By
__construct()	Constructor - Sets Email Preferences	Email
__destruct()	Destructor	Email
attach()	Assign file attachments	Email
batchBCCSend()	Batch Bcc Send. Sends groups of BCCs in batches	Email
cleanEmail()	Clean Extended Email Address: Joe Smith	Email
clear()	Initialize the Email Data	Email
initialize()	Initialize preferences	Email
isValidEmail()	Email Validation	Email
printDebugger()	Get Debug Message	Email
send()	Send Email	Email
setAltMessage()	Set Multipart Value	Email
setAttachmentCID()	Set and return attachment Content-ID	Email
setBCC()	Set BCC	Email
setCC()	Set CC	Email
setCRLF()	Set CRLF	Email
setFrom()	Set FROM	Email
setHeader()	Add a Header Item	Email
setMailType()	Set Mailtype	Email
setMessage()	Set Body	Email
setNewline()	Set Newline Character	Email
setPriority()	Set Priority	Email
setProtocol()	Set Protocol	Email
setReplyTo()	Set Reply-to	Email
setSubject()	Set Email Subject	Email
setTo()	Set Recipients	Email
setWordWrap()	Set Wordwrap	Email
validateEmail()	Validate Email Address	Email
wordWrap()	Word Wrap	Email

Method Details

__construct()

Constructor - Sets Email Preferences

The constructor can be passed an array of config values

Parameter Name	Type	Description
$config	array|null

Returns:

__destruct()

Destructor

Returns:

attach()

Assign file attachments

Parameter Name	Type	Description
$file	string	Can
$disposition	string	'attachment'
$newname	string|null
$mime	string

Returns: \Email

batchBCCSend()

Batch Bcc Send. Sends groups of BCCs in batches

Returns:

cleanEmail()

Clean Extended Email Address: Joe Smith

Parameter Name	Type	Description
$email	string

Returns: string

clear()

Initialize the Email Data

Parameter Name	Type	Description
$clearAttachments	bool

Returns: \Email

initialize()

Initialize preferences

Parameter Name	Type	Description
$config	array|\Config\Email

Returns: \Email

isValidEmail()

Email Validation

Parameter Name	Type	Description
$email	string

Returns: bool

printDebugger()

Get Debug Message

Parameter Name	Type	Description
$include	array	List

Returns: string

send()

Send Email

Parameter Name	Type	Description
$autoClear	bool

Returns: bool

setAltMessage()

Set Multipart Value

Parameter Name	Type	Description
$str	string

Returns: \Email

setAttachmentCID()

Set and return attachment Content-ID

Useful for attached inline pictures

Parameter Name	Type	Description
$filename	string

Returns: string

setBCC()

Set BCC

Parameter Name	Type	Description
$bcc	string
$limit	string

Returns: \Email

setCC()

Set CC

Parameter Name	Type	Description
$cc	string

Returns: \Email

setCRLF()

Set CRLF

Parameter Name	Type	Description
$CRLF	string

Returns: \Email

setFrom()

Set FROM

Parameter Name	Type	Description
$from	string
$name	string
$returnPath	string|null	Return-Path

Returns: \Email

setHeader()

Add a Header Item

Parameter Name	Type	Description
$header	string
$value	string

Returns: \Email

setMailType()

Set Mailtype

Parameter Name	Type	Description
$type	string

Returns: \Email

setMessage()

Set Body

Parameter Name	Type	Description
$body	string

Returns: \Email

setNewline()

Set Newline Character

Parameter Name	Type	Description
$newline	string

Returns: \Email

setPriority()

Set Priority

Parameter Name	Type	Description
$n	int

Returns: \Email

setProtocol()

Set Protocol

Parameter Name	Type	Description
$protocol	string

Returns: \Email

setReplyTo()

Set Reply-to

Parameter Name	Type	Description
$replyto	string
$name	string

Returns: \Email

setSubject()

Set Email Subject

Parameter Name	Type	Description
$subject	string

Returns: \Email

setTo()

Set Recipients

Parameter Name	Type	Description
$to	string|array

Returns: \Email

setWordWrap()

Set Wordwrap

Parameter Name	Type	Description
$wordWrap	bool

Returns: \Email

validateEmail()

Validate Email Address

Parameter Name	Type	Description
$email	string|array

Returns: bool

wordWrap()

Word Wrap

Parameter Name	Type	Description
$str	string
$charlim	int|null	Line-length

Returns: string